Lotes
La API de Lotes LATAM le permite reunir varios pagos en un solo lote y dispararlos todos a la vez, haciendo seguimiento del avance del conjunto.
Esta API está disponible en el entorno de sandbox.
Casos de Uso
- Pagar a varios proveedores en una sola operación.
- Aprobar un conjunto de pagos a la vez.
- Hacer seguimiento de cuántos pagos del lote ya se completaron y cuántos fallaron.
Cómo funcionan los lotes
Un lote comienza vacío. Al abrirlo, usted define hasta cuándo permanece abierto (expiresAt) y cuántos pagos acepta (maxSize). Los pagos entran al lote cuando usted los crea informando el batchRef del lote, y solo se disparan cuando el lote se procesa.
Toda creación o modificación de un lote debe enviar el header X-Idempotency-Key, para que repetir la llamada no abra dos lotes ni procese el mismo lote dos veces.
Recorrido de un lote
- Abra el lote, informando la vigencia y la capacidad máxima.
- Cree los pagos informando el
batchRefdel lote. Consulte la API de Pagos. - Procese el lote. Todos los pagos se disparan a la vez. Si el lote requiere aprobación, una única aprobación libera todos los ítems.
- Haga seguimiento del avance. La consulta del lote muestra el estado y cuántos pagos ya se completaron (
settledCount) y cuántos fallaron (failedCount). - Abandone el lote, si desiste. Un lote aún no procesado puede descartarse sin disparar ningún pago.
Estado del lote
El estado del lote se calcula a partir de sus pagos y usted nunca lo informa.
| Estado | Significado |
|---|---|
open | Abierto, recibiendo pagos |
pending_approval | Esperando aprobación |
processing | Pagos disparados, aún en curso |
settled | Todos los pagos se completaron |
partially_failed | Parte de los pagos se completó y parte falló |
abandoned | Descartado sin disparar |
expired | La vigencia terminó antes del procesamiento |
Un lote que llegó a un estado final (settled, partially_failed, abandoned o expired) no puede procesarse de nuevo. Para volver a pagar, abra otro lote.
Recursos Disponibles
Los recursos de la API de Lotes LATAM están disponibles en el API Reference.